home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Source Code / Think Class Libraries / File class library / readme.c < prev    next >
Encoding:
Text File  |  1994-11-30  |  3.6 KB  |  124 lines  |  [TEXT/KAHL]
  1. /*
  2.  
  3.   readme.c
  4.  
  5.      General information about this library/project.
  6.  
  7.   October 8, 1992  isl
  8.   
  9.   This code may be used, modified, and distributed free of charge and obligation
  10.   as long as the Symantec Copyright is honored.
  11.   
  12. */
  13.  
  14. /* =====================* /
  15. / *===---------------===* /
  16.  
  17. Notes:
  18.  
  19.  
  20. The File project is meant to augment the file classes supplied with TCL 1.1
  21. with the standard CFile as the superclass.
  22.  
  23. It provides the following facilities in addition to standard:
  24.  
  25. 1.    Custom icons for files and folders;
  26. 2.    Folder creation and access;
  27. 3.    Access to a file's path (limited to 255 characters, sorry);
  28. 4.    Improved methods for resource files;
  29. 5.    More general file information retrieval and manipulation;
  30. 6.    Specifying a file by creator and type;
  31. 7.    Emulation of the FSMakeFSSpec trap for System 6;
  32. 8.    Moving files to the Trash as an alternative to permanent erasure;
  33. 9.    Creation of files with unique names, and
  34. 10.    A local Gestalt flag, and
  35. 11.    Stationery awareness.
  36.  
  37.  
  38. You will find that my resource file class is mostly the standard CResFile while
  39. the data file class is exactly the original CDataFile.
  40.  
  41. The header file supplied with this project is the generic file I use for all my projects.
  42. You may find that a slimmer file will do just fine.
  43. IsleHeaders.h is meant to be precompiled for faster builds.
  44.  
  45. / *===-------------===* /
  46.  
  47. Class list:
  48.  
  49. 1. CIsleFile (subclass of CFile)
  50.     Implements the driver level general routines
  51.     
  52. 2. CIsleDataFile (subclass of CIsleFile)
  53.     Identical to the standard CDataFile but subclasses off of CIsleFile
  54.     
  55. 3. CFolder (subclass of CIsleFile)
  56.     Implements folder specific routines
  57.     
  58. 4. CIsleResFile (subclass of CIsleFile)
  59.     A slight variation of the standard CResFile
  60.     
  61. 5. CCustomIcon (subclass of CIsleResFile)
  62.     Implements custom icons for folders or files
  63.  
  64.  
  65. / *===---------------===* /
  66.  
  67. Build instructions:
  68.  
  69. These classes were designed to run under full TCL 1.1.  However, they will work
  70. with a bare-bones framework as well.  These classes rely little on other
  71. TCL classes.
  72.  
  73. An demo application using these classes will be posted to TCL-Talk in the first half
  74. of October,
  75.  
  76. To build a project with File classes you will need:
  77.  
  78. 1. Classes.
  79.     The File classes rely on some methods defined in the superclasses CFile and CObject.
  80.     They also access some global variables common to TCL.
  81.     Make sure to include the oop libraries and the MacTraps libraries as these
  82.     classes use toolbox calls and oop specific calls.
  83.     
  84. 2. Custom headers.
  85.     This distribution should contain a file called IsleHeaders.h.  This file may be
  86.     precompiled for faster builds.  File classes make no direct reference to this file as it is 
  87.     included automatically (Options:Prefix).
  88.     Cosmetics.h is referenced by this file and is also included with this distribution.
  89.     IconFamilies.h provides icon suite definitions for CCustomIcon.
  90.     
  91. 3. Resources.
  92.     Make sure to include the 'STR#', 'Estr', and the 'TMPL' resources
  93.     from this distribution in your project resource file.  These are error strings.
  94.  
  95.  
  96. / *===---------------===* /
  97.  
  98. Author:
  99.  
  100.     Igor Livshits                        e: igorl@ncsa.uiuc.edu
  101.     NCSA - 240 Computer Applications Building
  102.     University of Illinois
  103.     605 East Springfield Avenue, Champaign, Illinois 61820 
  104.     (217) 244-5606
  105.     Champaign-Urbana campus
  106.         
  107.     To steal some words from Jamie:
  108.         * I'm releasing this code with the hope that someone will get something
  109.          * out of it.  Feedback of any sort, even just letting me know that you're
  110.         * using it, is greatly appreciated!
  111.         
  112.     Thanks, Igor
  113.  
  114.  
  115. / *===---------------===* /
  116.  
  117. TCL-Talk:
  118.  
  119. List-                                         TCL-TALK@BROWNVM.brown.edu
  120. Requests/Administration-    LISTSERV@BROWNVM.brown.edu
  121. Anonymous FTP-                        ftp.brown.edu (/pub/tcl)
  122.  
  123. / *===---------------===* /
  124. / *=====================*/